<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_60) on Sun Dec 20 21:23:28 CET 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Container (gephi 0.9.0 API)</title>
<meta name="date" content="2015-12-20">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="Container (gephi 0.9.0 API)";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Container.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/gephi/io/importer/api/ColumnDraft.html" title="interface in org.gephi.io.importer.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/gephi/io/importer/api/Container.Factory.html" title="interface in org.gephi.io.importer.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/gephi/io/importer/api/Container.html" target="_top">Frames</a></li>
<li><a href="Container.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.io.importer.api</div>
<h2 title="Interface Container" class="title">Interface Container</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Container</span></pre>
<div class="block">A container is created each time data are imported by <b>importers</b>. Its
 role is to host all data collected by importers during import process. After
 pushing data into the container, its content can be analyzed to verify its
 validity and then be processed by <b>processors</b>. Thus, containers are
 <b>loaded</b> by importers and <b>unloaded</b> by processors.
 <p>
 See <a href="../../../../../org/gephi/io/importer/api/ContainerLoader.html" title="interface in org.gephi.io.importer.api"><code>ContainerLoader</code></a> for how to push graph and attributes data in the
 container and see <a href="../../../../../org/gephi/io/importer/api/ContainerUnloader.html" title="interface in org.gephi.io.importer.api"><code>ContainerUnloader</code></a> for how to retrieve data in the
 container.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mathieu Bastian</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/gephi/io/importer/spi/Importer.html" title="interface in org.gephi.io.importer.spi"><code>Importer</code></a>, 
<a href="../../../../../org/gephi/io/processor/spi/Processor.html" title="interface in org.gephi.io.processor.spi"><code>Processor</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.Factory.html" title="interface in org.gephi.io.importer.api">Container.Factory</a></span></code>
<div class="block">Container factory.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#closeLoader--">closeLoader</a></span>()</code>
<div class="block">Close the current loading and clean content before unloading.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/gephi/io/importer/api/ContainerLoader.html" title="interface in org.gephi.io.importer.api">ContainerLoader</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#getLoader--">getLoader</a></span>()</code>
<div class="block">Gets the container loading interface.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/gephi/io/importer/api/Report.html" title="class in org.gephi.io.importer.api">Report</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#getReport--">getReport</a></span>()</code>
<div class="block">Returns the report associated to this container, if it exists.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#getSource--">getSource</a></span>()</code>
<div class="block">If exists, returns the source of the data.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/gephi/io/importer/api/ContainerUnloader.html" title="interface in org.gephi.io.importer.api">ContainerUnloader</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#getUnloader--">getUnloader</a></span>()</code>
<div class="block">Get the container unloading interface.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#hasDynamicAttributes--">hasDynamicAttributes</a></span>()</code>
<div class="block">Returns true if this container contains elements that have dynamic
 attributes.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#hasSelfLoops--">hasSelfLoops</a></span>()</code>
<div class="block">Returns true if edges in this container are self-loops.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#isDynamicGraph--">isDynamicGraph</a></span>()</code>
<div class="block">Returns true if this container contains a dynamic graph.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#isMultiGraph--">isMultiGraph</a></span>()</code>
<div class="block">Returns true if this container contains a multigraph.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#setReport-org.gephi.io.importer.api.Report-">setReport</a></span>(<a href="../../../../../org/gephi/io/importer/api/Report.html" title="class in org.gephi.io.importer.api">Report</a>&nbsp;report)</code>
<div class="block">Sets a report this container can use to report issues detected when
 loading the container.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#setSource-java.lang.String-">setSource</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source)</code>
<div class="block">Sets the source of the data put in the container.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/gephi/io/importer/api/Container.html#verify--">verify</a></span>()</code>
<div class="block">This method must be called after the loading is complete and before
 unloading.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="setSource-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSource</h4>
<pre>void&nbsp;setSource(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;source)</pre>
<div class="block">Sets the source of the data put in the container. Could be a file name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - original source of data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>source</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getSource--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSource</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSource()</pre>
<div class="block">If exists, returns the source of the data.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>source of the data, or <code>null</code> if source is not
 defined.</dd>
</dl>
</li>
</ul>
<a name="getLoader--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoader</h4>
<pre><a href="../../../../../org/gephi/io/importer/api/ContainerLoader.html" title="interface in org.gephi.io.importer.api">ContainerLoader</a>&nbsp;getLoader()</pre>
<div class="block">Gets the container loading interface.
 <p>
 The <b>loader</b> is used by modules which put data in the container,
 whereas the <b>unloader</b> interface is used by modules which read
 containers content.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>containers loading interface</dd>
</dl>
</li>
</ul>
<a name="getUnloader--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnloader</h4>
<pre><a href="../../../../../org/gephi/io/importer/api/ContainerUnloader.html" title="interface in org.gephi.io.importer.api">ContainerUnloader</a>&nbsp;getUnloader()</pre>
<div class="block">Get the container unloading interface.
 <p>
 The <b>unloader</b> interface is used by modules which read containers
 content, whereas the <b>loader</b> is used for pushing data in the
 container.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>container unloading interface</dd>
</dl>
</li>
</ul>
<a name="setReport-org.gephi.io.importer.api.Report-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReport</h4>
<pre>void&nbsp;setReport(<a href="../../../../../org/gephi/io/importer/api/Report.html" title="class in org.gephi.io.importer.api">Report</a>&nbsp;report)</pre>
<div class="block">Sets a report this container can use to report issues detected when
 loading the container.
 <p>
 Report are used to log info and issues during import process. Only one
 report can be associated to a container.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>report</code> - set <code>report</code> as the default report for this
 container</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>report</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getReport--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReport</h4>
<pre><a href="../../../../../org/gephi/io/importer/api/Report.html" title="class in org.gephi.io.importer.api">Report</a>&nbsp;getReport()</pre>
<div class="block">Returns the report associated to this container, if it exists.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>report set for this container or <code>null</code> if no report
 is defined</dd>
</dl>
</li>
</ul>
<a name="verify--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verify</h4>
<pre>boolean&nbsp;verify()</pre>
<div class="block">This method must be called after the loading is complete and before
 unloading.
 <p>
 It aims to verify data consistency as a whole.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if container data is consistent,
 <code>false</code> otherwise</dd>
</dl>
</li>
</ul>
<a name="closeLoader--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeLoader</h4>
<pre>void&nbsp;closeLoader()</pre>
<div class="block">Close the current loading and clean content before unloading.</div>
</li>
</ul>
<a name="isDynamicGraph--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDynamicGraph</h4>
<pre>boolean&nbsp;isDynamicGraph()</pre>
<div class="block">Returns true if this container contains a dynamic graph.
 <p>
 A dynamic graph has elements that appear or disappear over time.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if dynamic, false otherwise</dd>
</dl>
</li>
</ul>
<a name="hasDynamicAttributes--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasDynamicAttributes</h4>
<pre>boolean&nbsp;hasDynamicAttributes()</pre>
<div class="block">Returns true if this container contains elements that have dynamic
 attributes.
 <p>
 Dynamic attributes are attributes with different values over time.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if dynamic attributes, false otherwise</dd>
</dl>
</li>
</ul>
<a name="hasSelfLoops--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasSelfLoops</h4>
<pre>boolean&nbsp;hasSelfLoops()</pre>
<div class="block">Returns true if edges in this container are self-loops.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if presence of self-loops, false otherwise</dd>
</dl>
</li>
</ul>
<a name="isMultiGraph--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isMultiGraph</h4>
<pre>boolean&nbsp;isMultiGraph()</pre>
<div class="block">Returns true if this container contains a multigraph.
 <p>
 A multi-graph is a graph that has several types of edges (i.e. edges with
 different labels).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if multigraph, false otherwise</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Container.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/gephi/io/importer/api/ColumnDraft.html" title="interface in org.gephi.io.importer.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/gephi/io/importer/api/Container.Factory.html" title="interface in org.gephi.io.importer.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/gephi/io/importer/api/Container.html" target="_top">Frames</a></li>
<li><a href="Container.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2015 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All rights reserved.</small></p>
</body>
</html>
